home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / secho20.zip / SECHO.DOC < prev    next >
Text File  |  1988-09-27  |  9KB  |  213 lines
  1. Welcome to Version 2.0 of SECHO...Special ECHO for the IBM machines.
  2.  
  3. Background...
  4.      I Love Color.  My Word Processors are set up in full color.  My
  5.      Database Programs are set up in full color.  Spreadsheets, Utilities,
  6.      EVERYTHING.  But the one thing that didn't have any color were my
  7.      batch files.  I tried adding it throught the usual means of ansi codes
  8.      and a small program to route these codes through ANSI.SYS, but this
  9.      was not only slow, but cumbersome, and you could only have 1 color on
  10.      each line.  Thus, Secho was born.
  11.      Secho is a replacment for the DOS echo command, but Secho supports MANY
  12.      formatting, color, and variable commands within each line to be echoed.
  13.      Trust me, you'll love it.
  14.  
  15. Technical Information...
  16.      Secho is written in Turbo Pascal Version 4.0.  As soon as it is
  17.      available, I will convert it to Turbo 5.0.  It was developed on a
  18.      8 MHZ Turbo XT, with a Nec V-20 processor, so if you find any timing
  19.      anomilies, drop me a line and I will clean them up!
  20.  
  21. How it works...
  22.      Secho works EXACTLY like the Dos echo command.  As long as the file
  23.      SECHO.EXE is available somewhere in Dos' path, it will work without
  24.      a hitch!  You simple enter SECHO <line of stuff>, and it is echoed
  25.      to the screen.  However, within that <line of stuff> you can have a
  26.      myriad of commands for changing color, drawing windows, positioning the
  27.      cursor, printing variables to the screen, and MORE!!!
  28.  
  29. The Commands...
  30.      A quick rundown before the actual syntax.  Many numerical parameters
  31.      need to be 2 digits.  This means that if you want the value of 1,
  32.      you have to enter 01.  The reason for this was space and speed, and
  33.      once you get used to it, it causes no headaches!
  34.  
  35. \a
  36.      This is the audible alarm.  There are no parameters, and it is a
  37.      replacment for the bell.  It has a fun Zip sound, which I spent a
  38.      good 45 minutes tuning, so if you don't like it...complain!!
  39.      Example: SECHO \a
  40.               This would sound the Alarm!
  41.  
  42. \b#
  43.      This sets the background colors of ALL following output.  The colors
  44.      are listed below.  The parameter for this command is one, and only
  45.      one digit.
  46.      Example: SECHO \b1
  47.               This would set the background color to blue.
  48.  
  49. \c
  50.      Very self explanitory.  This command will clear the screen.  No
  51.      parameters are used.
  52.      Example: SECHO \c
  53.               This would clear the screen. (Redundancy is one of my better
  54.               personal traits.)
  55.  
  56. \d
  57.      When executed, this command will display the current date to the
  58.      screen, in the current colors.  The format is "Sunday, July 22, 1988."
  59.      Example: SECHO \d
  60.               Obvious Result, yes?
  61.  
  62. \f##
  63.      The f command sets the foreground color.  It MUST be two digits.
  64.      Again, the list of colors are below.
  65.      Example: SECHO \f01
  66.               This would set the foreground color to blue.  A note, if you
  67.               were to enter SECHO \f1, an error message would appear, telling
  68.               you that "Err=2."  This means that the second digit of the
  69.               parameter is invalid.
  70.  
  71. \g
  72.      I don't really know why this is here, but I have found a couple uses
  73.      for it.  This command will display, in the current colors, the current
  74.      path you are in.
  75.      Example: SECHO \g
  76.               This would print to the screen your current position in the
  77.               directory tree.  ie: C:\APPS\DOS
  78.  
  79. \h#
  80.      The h command prints a number of backspaces.  The parameter can be only
  81.      one digit.
  82.      Example: SECHO Hello!\b6Goodbye
  83.               This would print Hello! to the screen, then immediatelly
  84.               backspace over it and print Goodbye.  Would be handy to have
  85.               a pause command, eh?  Read on!
  86.  
  87. \m
  88.      No parameters, this one just prints out the free RAM in the system, in
  89.      the current color parameters!
  90.      Example: SECHO Free Ram: \m
  91.               Would print Free Ram: 569,000 (or whatever you happen to have
  92.               free at the time!)
  93.  
  94. \p#
  95.      This is the afore-mentioned pause command.  Takes one parameter, which
  96.      can be only one digit.  If the number is between 1 and 9, it will
  97.      pause that many seconds.  If the number is 0, it will prompt the user
  98.      to press any key, and wait for a keypress.
  99.      Example: SECHO \p0
  100.               This would print " [PRESS ANY KEY] " to the screen, and await
  101.               a keypress.  When a key is hit, it will backspace over and
  102.               remove the press any key message.
  103.  
  104. \r#
  105.      Prints 1 - 9 carrage returns to the screen.  The parameter can be one
  106.      and only one digit long.
  107.      Example: Secho Hello!\r3Hello!
  108.               This would print Hello!, then three lines below, print hello!
  109.               again!
  110.  
  111. \s
  112.      Handy!  Outputs to the screen, in the current colors, the amount of
  113.      free space on the current drive.  It is in the format 367,203 bytes.
  114.      If applicable, i.e. the drive is larger than one megabyte, it will
  115.      also convert this to meg.
  116.      Example: Secho Drive Space: \s
  117.               The output from this command could look like this:
  118.               Drive Space: 3,250,585 bytes free. (  3.1 Meg)
  119.  
  120. \t
  121.      Like the \d command, this will output the current time, according
  122.      to the system clock.
  123.      Example: Secho \t
  124.               The output would look like this: 12:32 pm
  125.  
  126. \wX1Y1X2Y2P
  127.      This is the draw a window command.  It is a bit involved.  The parameter
  128.      is 9 digits long, and the breakdown is as follows.
  129.      Digits one and two are the x coordinates of the upper left corner of
  130.      the window.
  131.      Digits three and four are the y coordinates of the upper left corner
  132.      of the window.
  133.      Digits five and six are the x coordinates of the lower right corner.
  134.      Digits seven and eight are the y coordinates of the lower right corner.
  135.      Note, the coordinates MUST be 2 digits each, so if you want position 1,
  136.      you MUST use 01.
  137.      Digit nine is the window style.
  138.         If it is a one, the window will be drawn with double lines.
  139.         If it is a two, the window will be drawn with single lines.
  140.         If it is a three, the window will have double horizontal lines,
  141.            and single vertical lines.
  142.         If it is a four, the window will have single horizontal lines,
  143.            and double vertical lines.
  144.      Example: SECHO \w010140123
  145.               This will draw a window with the upper left corner having
  146.               the coordinates of (01,01) and the lower right corner having
  147.               the coordinates of (40,12).  The window will have double
  148.               horizontal lines, and single vertical lines.
  149.  
  150. \xXXYY
  151.      This is screen positioning.  It have a FOUR digit parameter.
  152.      The first two digits are the x value, and the second two are the y
  153.      value.
  154.      Example: SECHO \x4012
  155.               This will position the cursor at (40,12), and subsequent
  156.               output will start there.
  157.  
  158. \z
  159.      Screen ZAP!  This is another command I added as a special effect.
  160.      It will cause the screen to fade out, then clear.  Just like the
  161.      \c command, but more fun to watch.  Try it!
  162.  
  163. \-String,#1,#2
  164.      This is the repeat function.  What it will do, is repeat String #2 times.
  165.      The first output of String will be in color #1, the second in #1+1, etc
  166.      It cycles colors, and when it reaches 15, it reverts to color 1.
  167.      Try it...its neat!
  168.  
  169. }filename
  170.      This will only work if the } is the VERY first thing on the command line.
  171.      This is what is called file mode.  Look at TEST.BAT to see it implemented.
  172.      If you are going to output lots of data, doing it line by line from a
  173.      batch file can be SLOW.  The } command lets you create a file of secho
  174.      commands, which are read by secho.  This method is MUCH faster then
  175.      normal command line mode, but also requires a data file.
  176.      Again, look at TEST.BAT, and TEST.DAT for more information.
  177.  
  178. The Colors!!!!
  179.  
  180.     This is a list of Color that secho can use!
  181.  
  182.